Skip to content

Preview for 26.06 release notes + make get-source#1353

Open
nrichers wants to merge 6 commits into
mainfrom
nrichers/sc-16263/release-notes-for-26-06
Open

Preview for 26.06 release notes + make get-source#1353
nrichers wants to merge 6 commits into
mainfrom
nrichers/sc-16263/release-notes-for-26-06

Conversation

@nrichers
Copy link
Copy Markdown
Contributor

@nrichers nrichers commented May 26, 2026

What and why?

This PR enables a temporary preview of the 26.06 release notes on the docs staging site and runs make get-source to refresh our library files.

Relates to:

BECK, PLEASE REMEMBER TO REMOVE THIS BRANCH REF BEFORE MERGING,

How to test

Wait for the Validate docs site workflow to finish, then check the live preview:

After making changes to the release notes draft, rerun the same workflow to refresh the preview site.

What needs special review?

Review the release notes content for accuracy and completeness.

Dependencies, breaking changes, and deployment notes

Release notes

N/A — preview only

Checklist

  • What and why
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied

Points to nrichers/sc-16263/release-notes-for-26-06 branch in release-notes repo.
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers changed the title Preview for 26.06 release notes Preview for 26.06 release notes + make get-source May 26, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

with:
repository: validmind/release-notes
path: site/_source/release-notes
ref: nrichers/sc-16263/release-notes-for-26-06
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
ref: nrichers/sc-16263/release-notes-for-26-06

@validbeck, please remember to remove this line before merging.

@nrichers nrichers requested a review from validbeck May 26, 2026 03:48
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers added the internal Not to be externalized in the release notes label May 26, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Execute training notebooks for PRs

✓ INFO: Live previews are available —

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

PR Summary

This pull request introduces several key enhancements and fixes:

  1. Deployment Workflows Updates:

    • In the production, staging, and PR preview deployment workflows, the AWS S3 sync commands have been updated to include a cache-control header (--cache-control "no-cache, max-age=0, must-revalidate"). This change ensures that the deployed documentation is always fetched fresh without caching delays.
    • The docs validation workflow now checks out release-notes from a specific branch (nrichers/sc-16263/release-notes-for-26-06), ensuring that the correct release notes are used during deployment.
  2. Documentation Template Update:

    • The generated timestamp in the HTML footer of the documentation template has been updated to reflect a new generation date and time.
  3. Notebook Enhancements:

    • In one of the test configuration notebooks, the API endpoint has been updated from a localhost URL to a production endpoint (https://app.prod.validmind.ai/api/v1/tracking) and placeholder API credentials have been updated to safer dummy values.
    • A complete new quickstart notebook for model documentation using OIDC device flow has been added. This notebook guides users through an alternative authentication flow (OIDC device authorization flow) and provides a comprehensive walkthrough from setup to running tests and generating documentation.
  4. Release Notes Update:

    • The release notes configuration now includes an additional field (subtitle) in the fields array, allowing for more detailed release information.

Overall, these changes improve deployment reliability by enforcing fresh content delivery, enhance documentation clarity, and extend the available authentication options for users.

Test Suggestions

  • Verify that the docs deployment workflows (prod, staging, and PR preview) sync files with the expected cache-control headers and trigger CloudFront invalidations correctly.
  • Run the validation workflow to ensure that the correct release notes branch is checked out and integrated.
  • Execute the updated notebooks to confirm that the API endpoint changes correctly direct to the production environment and that no sensitive credentials are exposed.
  • Manually test the new quickstart notebook to validate the OIDC device flow sign-in process and confirm that it properly documents the complete guide.
  • Review the rendered documentation from the updated template to ensure the new timestamp and layout changes are correctly applied.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants